home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / fdc_320.zip / FDC-320.DOC < prev    next >
Text File  |  1991-08-14  |  21KB  |  494 lines
  1.  
  2.                         ┌─────────────────────────┐
  3.                         │  FILE DOWNLOAD COUNTER  │
  4.                         └─────────────────────────┘
  5.                       
  6.                               Version 3.20
  7.  
  8.                              August 14, 1991
  9.  
  10.                             ─────────────────
  11.                             USER FEE REQUIRED
  12.                             ─────────────────
  13.  
  14.                                Written by:
  15.                            Brandon M. Bachman
  16.  
  17.                              Distributed By:
  18.                         The Software Garden BBS
  19.  
  20.                        801-292-3308 (HST V.42Bis)
  21.  
  22.                       PCRelay routable -> SOFTGARD
  23.  
  24.  
  25.  
  26.       Copyright (C) 1990-91 by Brandon M. Bachman.  All Rights Reserved.
  27.  
  28.  
  29.  
  30.  
  31.  
  32. ┌───────────────────┐
  33. │ TABLE OF CONTENTS │
  34. └───────────────────┴──────────────────────────────────────────────────────
  35.  
  36.            ┌─────────┐
  37.            │ General │
  38.            └─────────┘
  39.            Overview ..................................... 1-1
  40.            Program Features ............................. 1-2
  41.            Registrered and Unregistered Versions ........ 1-3
  42.            Why Should I Register? ....................... 1-4
  43.            Disclaimer ................................... 1-5
  44.            License ...................................... 1-6
  45.            System Requirements .......................... 1-7
  46.            Files in the FDC Archive ..................... 1-8
  47.  
  48.            ┌──────┐
  49.            │ How? │
  50.            └──────┘
  51.            How FDC Operates ............................. 2-1
  52.            Installation ................................. 2-2
  53.            A Configuration File ......................... 2-3
  54.            Starting New with FDC ........................ 2-4
  55.            Removing FDC Entries ......................... 2-5
  56.            Log File ..................................... 2-6
  57.            Word Wrapping ................................ 2-7
  58.            Formats For Recording Download Count ......... 2-8
  59.  
  60.            ┌───────────────┐
  61.            │ Configuration │
  62.            └───────────────┘
  63.            The Configuration File ....................... 4-1
  64.            Sample Configuration File .................... 4-2
  65.  
  66.            ┌──────┐
  67.            │ Why? │
  68.            └──────┘
  69.            Operational Details .......................... 5-1
  70.            Examples of Command Line Arguments ........... 5-2
  71.            Common Questions and Answers ................. 5-3
  72.  
  73.            ┌───────┐
  74.            │ What? │
  75.            └───────┘
  76.            Technical Support ............................ 6-1
  77.            Other Programs by Brandon M. Bachman ......... 6-2
  78.  
  79.  
  80.  
  81. ┌──────────┐
  82. │ OVERVIEW │                                                          1-1
  83. └──────────┴─────────────────────────────────────────────────────────────
  84. FDC will edit the descriptions in PCBoard's DIR files with the number of
  85. times the file has been downloaded from your BBS.
  86.  
  87. FDC makes it easy for you and your users to see instantly which files are
  88. the most popular, and give you an idea of what software you should keep
  89. online or download and which programs are "dead wood" to be removed.
  90.  
  91.  
  92. PROGRAM FEATURES                                                       1-2
  93. ──────────────────────────────────────────────────────────────────────────
  94. ■ Automatically finds new downloads since the last date FDC was run.
  95.  
  96. ■ Reads any size (extremely large) DOWNLOAD.TXT files.
  97.  
  98. ■ Creates a 'customizable' bulletin of the most popular files. (FDC-BLT)
  99.  
  100. ■ Counts as many as 2,000,000,000 downloads of a single file!.
  101.  
  102. ■ Auto word wraps the description lines to *any* column you would like
  103.   leaving the "Uploaded by:" line undisturbed with word wrapping.
  104.  
  105. ■ Log file output (in PCBoard format) to monitor the program.
  106.  
  107. ■ Will run smoothly in your nightly event.
  108.  
  109. ■ Popular with users and SysOps as a guide to good programs.
  110.  
  111. ■ Supports entries made from Bimodem in your DOWNLOAD.TXT file.
  112.  
  113. ■ Creates a database of all un-processed files to re-try on future runs
  114.   therefore making the count 100% accurate.
  115.  
  116. ■ Written in Borland C++ for fast compact code.
  117.  
  118.  
  119.  
  120. REGISTERED AND UNREGISTERED VERSIONS                                   1-3
  121. ──────────────────────────────────────────────────────────────────────────
  122. "File Download Counter" is not Public Domain or Free ware.  Unregistered
  123. versions are 21 day evaluation copies only, after which they should either
  124. be destroyed or a license agreement purchased.  It's only $15 so please
  125. register your copy today.  Read 'REGISTER.TXT' included with this archive
  126. for more information.
  127.  
  128.  
  129.  
  130. WHY SHOULD I REGISTER?                                                 1-4
  131. ──────────────────────────────────────────────────────────────────────────
  132. ■ FDC will count beyond the 25 download count limit if registered.
  133.  
  134. ■ Free technical support via the Software Garden Bulletin Board.
  135.  
  136. ■ Lifetime free updates of all future versions guaranteed.
  137.  
  138. ■ Help support future updates and development of FDC.
  139.  
  140. ■ Support the shareware concept.
  141.  
  142.  
  143.  
  144. DISCLAIMER                                                             1-5
  145. ──────────────────────────────────────────────────────────────────────────
  146. The authors make no warranties or representation of any kind, expressed or
  147. implied, with respect to "File Download Counter", or its quality,
  148. reliability, or performance, or its merchantability or fitness for any
  149. purpose.  The user assumes the entire risk as to the quality, performance
  150. and reliability of the software and documentation.
  151.  
  152.  
  153.  
  154. LICENSE                                                                1-6
  155. ──────────────────────────────────────────────────────────────────────────
  156. The "File Download Counter" ("The Software") is COPYRIGHT 1990-91 by
  157. Brandon M. Bachman, ALL RIGHTS RESERVED WORLDWIDE.
  158.  
  159. A license grants you a nonexclusive, nontransferable license to use
  160. "File Download Counter" software on a single central processing unit at any
  161. one time.  Site licenses are available upon request for Networks exceeding
  162. 3 remote nodes.
  163.  
  164. You may NOT engage in, nor permit third parties to engage in, any of the
  165. following :
  166.  
  167.         A)  Sell, rent, sub-license, lease, or grant other rights
  168.             of this software to others.
  169.  
  170.         B)  Attempt to disassemble, decompile, or reverse engineer
  171.             the software or the files it generates in any way.
  172.  
  173.         C)  Make alterations of any kind in the files of this
  174.             software, except as noted below.
  175.  
  176.         D)  Collect fees for distribution of the software.
  177.  
  178. The authors of the software grant you a license to use this software as
  179. long as you meet the above conditions.  Any violation of the above
  180. conditions will result in the termination of your license to use this
  181. software.  Upon termination of this license for any reason, you must
  182. stop using the software and destroy all copies of it in your possession
  183. immediately.
  184.  
  185. The author(s) of this software are not liable for damages suffered as a
  186. result of the improper use, proper use, or inability to use this
  187. software.  This type of disclaimer is prohibited by law in some states,
  188. and is therefore void in those states.
  189.  
  190.  
  191.  
  192. SYSTEM REQUIREMENTS                                                    1-7
  193. ──────────────────────────────────────────────────────────────────────────
  194. To run "File Download Counter" you will need the following:
  195.  
  196. 1.  IBM PC/XT/AT, PS/2 or 100% compatible machine.
  197. 2.  Color or Monochrome Graphics adapter.
  198. 3.  MS-DOS 3.0 or higher.
  199. 4.  PCBoard BBS Software.
  200.  
  201.  
  202.  
  203. FILES IN THIS ARCHIVE                                                  1-8
  204. ──────────────────────────────────────────────────────────────────────────
  205. "File Download Counter" is distributed as a archival file "FDC-XXX.ZIP"
  206. You must have PkZip v1.10 or later to extract the files listed below.
  207. PkZip v1.10 is Shareware and is available on many computer bulletin boards.
  208. Files in the archive include:
  209.  
  210.        FDC.EXE      -  The "File Download Counter" program.
  211.        SAMPLE.CFG   -  Sample configuration file.
  212.        FDC-320.DOC  -  This documentation file.
  213.        HISTORY.DOC  -  List of improvements to FDC, and history.
  214.        REGISTER.DOC -  Information on registering your copy.
  215.        README.DOC   -  Important information for new and old users.
  216.        USERS.DOC    -  List of registered users.
  217.        COMMENTS.DOC -  List of comments from other users of FDC.
  218.  
  219. Sysops are free to distribute uregistered versions of FDC as a complete
  220. unaltered archive only.
  221.  
  222.  
  223.  
  224. HOW FDC OPERATES                                                       2-1
  225. ──────────────────────────────────────────────────────────────────────────
  226. FDC will read the DOWNLOAD.TXT file created by PCBoard, and count all
  227. recently downloaded files since the last time File Download Counter was
  228. executed successfully.  It then searches the DIR files for a match.  Then
  229. FDC inserts the number of times <#> the file has been downloaded into the
  230. file description in the DIR file.  This will usually take up 4 or 5
  231. characters of the description.  If in doing so the description gets pushed
  232. too far to the right it will auto word wrap and create a new line, or add to
  233. the secondary line if it exists.  Therefore none of the file descriptions
  234. will be lost.  If desired, you can have FDC enter a separate line of text
  235. which indicates how many times the program has been downloaded.
  236.  
  237. Here is a sample of what FDC will do to the file descriptions in the DIR
  238. file.
  239.  
  240. Example of Style #1 and #2
  241. ──────────────────────────
  242. FILENAME.ARC   35252  06-27-90  <23> This is the description of the file.
  243. FILE-TWO.ZIP  213445  06-23-88  <11> This is another description.
  244. NEXTFILE.ZIP  243536  06-21-90  <14> This one has been downloaded 14 times,
  245.                               | and the description is auto word-wrapped.
  246. FILEFOUR.LZH  246246  05-12-90  <13> File Four v3.3, description.  With
  247.                               | this entry word wrapped, the "Uploaded by:"
  248.                               | line is not disturbed.
  249.                               | Uploaded by: Brandon Bachman
  250.  
  251. Example of Style #3
  252. ───────────────────
  253. FILENAME.ARC   35252  06-27-90  This is the description of the file.
  254.                               | Downloaded 23 times.
  255. FILE-TWO.ZIP  213445  06-23-88  This is another description.
  256.                               | Downloaded 12 times.
  257. NEXTFILE.ZIP  243536  06-21-90  This one has been downloaded 14 times,
  258.                               | and the description is auto word wrapped.
  259.                               | Downloaded 1234 times.
  260. FILEFOUR.LZH  246246  05-12-90  File Four v3.3, description.  With
  261.                               | this entry word wrapped, the "Uploaded by:"
  262.                               | Uploaded by: Brandon M. Bachman
  263.                               | Downloaded 233 times.
  264.  
  265.  
  266.  
  267. INSTALLATION                                                           2-2
  268. ──────────────────────────────────────────────────────────────────────────
  269. To install "File Download Counter" you must have the PKZip program
  270. available, then create a sub-directory for "File Download Counter" on your
  271. hard disk.  Enter the sub-directory and un-Zip the files.  Here is an
  272. example of how you might do this:
  273.  
  274.  
  275.            E:                     (Go to E: drive)
  276.            CD\                    (Go to the root directory)
  277.            MD FDC                 (Create E:\FDC sub-directory)
  278.            CD FDC                 (Go into the E:\FDC sub-directory)
  279.            COPY A:\FDC-320.ZIP    (Copy the program from drive A:)
  280.            PKUNZIP FDC-320.ZIP    (UnZip the program into the directory)
  281.  
  282.  
  283.  
  284. CONFIGURATION FILE                                                     2-3
  285. ──────────────────────────────────────────────────────────────────────────
  286. After you complete the installation you must then edit the FDC.CFG file
  287. included in this archive to your needs.  Read the  "Sample Configuration
  288. File" and "Operational Details" sections below for instructions.
  289.  
  290.  
  291.  
  292. STARTING NEW COUNT                                                     2-4
  293. ──────────────────────────────────────────────────────────────────────────
  294. First time users must initialize FDC by using the command line argument
  295. /START.  This will start the counters of FDC from the beginning of your
  296. DOWNLOAD.TXT file, thus counting all past downloads.
  297.  
  298. If you have been running FDC for a while but would like to restart the
  299. download count then run FDC with the /STRIP command line argument and
  300. the run it again with the /START argument.
  301.  
  302.  
  303.  
  304. STRIPPING FDC ENTRIES                                                  2-5
  305. ──────────────────────────────────────────────────────────────────────────
  306. If you would like to remove all entries made by FDC you may use the /STRIP
  307. command line argument to do so.  You will then need to run FDC with the
  308. /START command line argument to re-initialize FDC.  This is useful if you
  309. decide to switch from one style of editing your DIR files to another.
  310. (ie., STYLE=1 and you would like STYLE=3).
  311.  
  312.  
  313.  
  314. LOG FILE                                                               2-6
  315. ──────────────────────────────────────────────────────────────────────────
  316. If you would like record a log file of all FDC's activities use the
  317. argument LOG=filename in the FDC.CFG, where filename is the complete path
  318. and file name of the LOG file.  The format of the LOG file conforms to
  319. PCBoard's, so you can specify the LOG file as the CALLER log created by
  320. PCBoard if you wish.  Doing so will help cut down on many logs files
  321. clogging up your systems.
  322.  
  323.  
  324. WORD WRAPPING                                                          2-7
  325. ──────────────────────────────────────────────────────────────────────────
  326. FDC handles word wrapping in two ways.  If a file description requires
  327. word wrapping, FDC first searches for the "|" character in the secondary
  328. line of your file description, and when found will word wrap to the space
  329. following the "|" character.  However some sysops like to have all their
  330. secondary lines of the descriptions lined up on columns other than the
  331. default of the 32nd column by PCBoard.  You can change the default by
  332. using the argument CHAR=xx, where xx is the column or number of characters
  333. to word wrap to.
  334.  
  335. FDC will not disturb the "Uploaded by:" line when word wrapping.
  336.  
  337.  
  338.  
  339. THREE FORMATS FOR RECORDING DOWNLOAD COUNT!                            2-8
  340. ──────────────────────────────────────────────────────────────────────────
  341. FDC now supports three different formats for recording the number of times
  342. a file has been downloaded.  The first is the default which will put
  343. <##> in the first few characters of the first line of the files description
  344. in the DIR file.  The second will do the same as the first, however it will
  345. not word wrap but truncate all descriptions which exceed 79 characters.
  346. The third will insert a separate line at the end of the secondary lines of
  347. the description but before the "Uploaded by:"  This line will look like
  348. this:
  349.                    "| Downloaded 45 times."
  350.  
  351. If you perfer a differnet wording you may change the format to anyway
  352. you would like to editing the TEXT= parameter in the .CFG file.
  353.  
  354. By default FDC will insert this line starting at the 32nd column, however
  355. if you would like it to be inserted at another column simply use the
  356. CHAR=xx option specified section 2.9.
  357.  
  358. To implement one of the various format of recording the number of times
  359. downloaded use the STYLE=x option, where x is the number of the style you
  360. would like.
  361.  
  362.  
  363.  
  364. CONFIGURATION FILE                                                     4-1
  365. ──────────────────────────────────────────────────────────────────────────
  366. FDC daily operations are determined by the way you setup the FDC.CFG file.
  367. The configuration file must be called 'FDC.CFG' and be in the directory
  368. from which you run FDC.EXE.  It is critical that you take care in setting
  369. up this file, instructions for doing so are found in the "Sample
  370. Configuration File" section below and the above sections.
  371.  
  372. If you wish to have mulitple configuration files you may use the /CFG=
  373. command line argument.  If you wanted to use the configuration files
  374. NEWCFG.CFG and NEWCFG.DAT you would execute FDC with the command line
  375. "FDC /CFG=NEWCFG"  Note FDC will automatically apend the .CFG, .P and .S
  376. to the file names for the configuration file and data file names
  377. respectfully.
  378.  
  379.  
  380.  
  381. SAMPLE CONFIGURATION FILE                                              4-2
  382. ──────────────────────────────────────────────────────────────────────────
  383. Please refer to the SAMPLE.CFG file for a sample confgiuration file.
  384.  
  385. You may use any standard ASCII text editor to edit the SAMPLE.CFG file
  386. found in this archive, or to create your own.
  387.  
  388. Change the data in the SAMPLE.CFG to your needs and rename it FDC.CFG
  389.  
  390.  
  391.  
  392. OPERATIONAL DETAILS                                                    5-1
  393. ──────────────────────────────────────────────────────────────────────────
  394. After you have your FDC.CFG edited to your needs then type "FDC" and watch
  395. the wiz-bangs fly!  FDC will let you know if your FDC.CFG file may have
  396. errors.
  397.  
  398. NOTE: The first time you run the program it will NOT find any new files,
  399. because it will set the last run pointer to the last time you edited the
  400. FDC.CFG file.  If it is the first time you have run FDC use the /START
  401. switch to initialize FDC.  See "Starting New Count" above for more
  402. information on the /START command line argument.
  403.  
  404. To update your recent downloads every day, put FDC in your EVENT.SYS
  405. file, it will run smoothly in an event.  If there is an error, it will
  406. sound a beep, pause 10 seconds and then exit.
  407.  
  408.  
  409.  
  410. EXAMPLES OF COMMAND LINE ARGUMENTS TO RUN FDC, AND THE RESULTS         5-2
  411. ──────────────────────────────────────────────────────────────────────────
  412.  
  413.     1.  FDC
  414.  
  415.         This runs FDC at settings in the FDC.CFG file.
  416.  
  417.     2.  FDC /START
  418.  
  419.     This will run FDC and initialize the count from the beginning of
  420.     of the download.txt file.
  421.  
  422.     3.    FDC /STRIP
  423.  
  424.     This will run FDC and have it strip out all entries in your DIR
  425.     files that FDC made.  This is useful if you need to start the
  426.     the count over for FDC.
  427.  
  428.     4.  FDC /CFG=NEWCFG
  429.  
  430.         This will run FDC using the NEWCFG.CFG, and NEWCFG.T filenames
  431.         for the configuration file, and the data files respectfully.
  432.  
  433.  
  434.  
  435. COMMON QUESTIONS & ANSWERS                                             5-3
  436. ──────────────────────────────────────────────────────────────────────────
  437. Q.  I am a new user with File Download Counter and I it is not counting
  438.     my downloads.
  439.  
  440. A.  Make sure when you first run FDC to type "FDC /START" to initialize
  441.     the count in your DIR files.
  442.  
  443.  
  444. Q.  When I register FDC will I need to call your BBS to obtain future
  445.     registered updates, and will there be a fee for upgrading.
  446.  
  447. A.  FDC is self registering for all future versions, you can simply
  448.     download a copy from a distributor BBS.  There is and never will be
  449.     and additional fee for upgrading FDC even if prices do increase,
  450.     once you have are a registered user you may upgrade for free.
  451.  
  452.  
  453.  
  454. TECHNICAL SUPPORT                                                      6-1
  455. ──────────────────────────────────────────────────────────────────────────
  456. The latest version of "File Download Counter" software and technical
  457. support are available from:
  458.  
  459.   The Software Garden BBS            Join the FDC Support (2) Conference
  460.   801-292-3308 (USR HST V.42Bis)     to download the newest versions, ask
  461.   PCRelay routable -> SOFTGARD       questions, and offer suggestions.
  462.   FidoNet Node (1:311/7)
  463.  
  464. Or write to:  Brandon M. Bachman
  465.               1680 East 400 South Circle
  466.               Bountiful, Utah  84010
  467.  
  468.  
  469. OTHER PROGRAMS BY BRANDON M. BACHMAN                                   6-3
  470. ──────────────────────────────────────────────────────────────────────────
  471.  
  472.  
  473. What Happened Today v2.00
  474. ─────────────────────────
  475. Displays what happened in history on a given date (either system or
  476. manually set) date. Many display options!  Also creates BBS bulletins
  477. or news, and supports PCB 14.5+ @Xhh codes.  Five history databases
  478. available including: Sports, USA World, Science and Technology, Art,
  479. Entertainment and Media.  Many new dates added weekly.
  480.  
  481. Download as: WHT-200-ZIP  (Includes Sports History Library)
  482.  
  483.  
  484. Mail Time v3.00
  485. ───────────────
  486. Sysops utility that creates/updates bulletins and news on when the last
  487. echo mail run to the BBS occurred.  Supports all mail networks, and
  488. universal to all BBS software, although it will also support PCBoard
  489. 14.5+ @Xhh codes for color.  Many date and time format options.
  490. Includes PCBoard 14.5+ compatible log file output.
  491.  
  492. Download as: MT-300.ZIP
  493.  
  494.